home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / fido / jm950618.lha / docs / jamscan.doc < prev    next >
Text File  |  1995-01-19  |  11KB  |  312 lines
  1.  
  2.  
  3.                          -==* JamScan 0.70 *==-
  4.                            By James McOrmond
  5.  
  6.                            January 19th 1995
  7.  
  8.  
  9.  
  10.  
  11.  
  12. What is JamScan?
  13.  
  14. JamScan is a complete replacement for JBundle, an Arexx script I wrote
  15. last year, to bundle up uncompressed packets of mail, and to add them
  16. to Xferq.library to be sent out during a session.
  17.  
  18. JamScan does more than JBundle ever did, and it also does it much faster!
  19.  
  20. (JamScan is also pure for those of you that want things as fast as
  21. possible and like to make things resident)
  22.  
  23. The reason I wrote JamScan at this time, is that with the release of
  24. JamMail, I figured people would want a relatively fast and easy to use
  25. program that will fix up the files in their outbound directory.
  26.  
  27. Note: JamScan, and most Jam* utilities, all require AmigaDos2.0 or greater.
  28.  
  29.  
  30. How does it work?
  31.  
  32. When you run JamScan, it will check for an Env: variable named "JAMSCAN"
  33. and if it exists, it will use the contents as the filename for the config
  34. file.  If no ENV: variable exists, the default is Mail:JamScan.cfg.
  35.  
  36. After reading the config file, it will scan your packets directory for
  37. files that fit any of your route patterns.  If the filename also fits the
  38. pattern "#?.?ut", it will compress the packet up into a bundle using
  39. the archiver configured (LHA default).
  40.  
  41. If it finds a bundle in the outbound directory, it will make sure that
  42. the file is being sent to that system (if your tosser already does the
  43. archiving, this is what you'll likely be using).  This method is not as
  44. safe as the first option, but it is required until more tossers are
  45. Xferq.Library aware.
  46.  
  47. The priority that these files are sent with is configured one of two ways.
  48. If you specify "Hold", "Crash", or "Direct", the file will have the the
  49. priority that the specific type has (Defaults are: -50 for hold, +30 for
  50. direct and +50 for crash).  If this is a bundle that JamScan is just
  51. trying to add to Xferq a setting of "Norm" will result in a priority of
  52. 0.  If this is a Bundle that JamScan has just added a packet to, it will
  53. check the 3rd last character in the origional filename and set the
  54. priority appropriate to that character.  (C=Crash, D=Direct, H=Hold).
  55.  
  56.  
  57.  
  58. How Do I install JamScan?
  59.  
  60. JamScan is very easy to install.  There are really only two relevent
  61. files.  The JamScan binary itself should be put somewhere in your search
  62. path.  If you have a directory where Networking software goes, this is
  63. likely a good place.  The other file is your config file.  I myself have
  64. the config file in my Mail: directory, but you can locate it wherever you
  65. wish.  If your config file is not Mail:JamScan.cfg, you need to specify
  66. the full path name to get to your config file in the JamScan Environment
  67. variable.
  68.  
  69. JamScan requires at least a stack of 15000 bytes.
  70.  
  71.  
  72.  
  73. Configuring JamScan:
  74.  
  75. There are 8 different commands that JamScan understands in its config
  76. file.  They are as follows:
  77.  
  78. HOST    - Your Host address
  79. HOLD    - The default Priority for "Hold" mail       -50
  80. DIRECT  - The default Priority for "Direct" mail      30
  81. CRASH   - The default priority for "Crash" mail       50
  82. BUNDLES - The Directory Bundles will be placed
  83. PACKETS - The directory Packets will be searched for
  84. PKTS    - The directory temporary compression directories will be made
  85. ROUTE   - The actual Routing command.
  86.  
  87.  
  88. The "Packets" and the "Pkts" directories must be on the same device.  I
  89. have placed the Pkts directory as a Sub-directory in the Packets
  90. directory, you may wish to do the same.
  91.  
  92. The only keyword that is absolutely required is at least one ROUTE
  93. keyword.  Without any ROUTE lines, JamScan won't do anything.
  94.  
  95.  
  96.  
  97. How do I setup a Route line?
  98.  
  99. A route line can have 6 arguments on the line.  The first two are
  100. mandatory, but the rest two are not.
  101.  
  102. The first argument is the filename pattern.  This is the filename as it
  103. appears in your PACKETS directory.  Each name in this field should end
  104. with a #? unless you are wanting to specify the whole filename.  This
  105. field uses full AmigaDos2.0 pattern matching.  This can get really
  106. powerful and complicated, so you may want to read your AmigaDos manual
  107. for some hints on using strange patterns.
  108.  
  109. The Second Argument, is the Xferq.Library compatible address that the
  110. file will be sent to.  This can be anything from a single number, which
  111. it will assume is another node in your Net (by using the defaults in
  112. your "HOST" keyword, and the Host address you have setup with Xferq
  113. itself), to a full 5d FTN address.
  114.  
  115. As of version 0.58 of JamScan, the destination address in the second
  116. argument is allowed to have wild cards.  Any of the numeric fields can
  117. be replaced by an * character (only an * character, not any other wild
  118. card character).  This allows JamScan to require a much smaller config
  119. file and doesn't require you to add a configuration line for every single
  120. system you might want to send mail to.
  121.  
  122. With version 0.59 of JamScan, it will now read .FLO type files.  At the
  123. very basic level, route statements can be setup to route all .FLO style
  124. files to its own 4d address (using the * wildcards) which makes the
  125. config file very small.
  126.  
  127. You can also put a Non-Fidonet address type in this field, and it will
  128. work fine.
  129.  
  130. The following fields can be in any order, as long as they are the last
  131. options on the line.
  132.  
  133. The first two fields are the Archiver type and the priority.  The defaults
  134. are the "Lha" archiver, and a "Norm" priority setting.  Either or both
  135. of these two settings can be left out, and they can be in either order.
  136.  
  137. The outbound compressors supported are "Lha", "Lzh", "Arc", "Zoo", and
  138. "Zip".  A setting of "Non" is now also supported, so any packets found
  139. in the "PACKETS" directory, will not be compressed before sending them
  140. out.
  141.  
  142. Also, if one of these two fields is found to be a number (non-0 value)
  143. then this number will be used directly as the priority that the files
  144. will be sent with.
  145.  
  146. Also, on this line, there can be a "MOVE" command, followed by a full
  147. directory name.  This directory will be used as an alternative
  148. location to put bundles or packets that JamMail creates.
  149.  
  150. Last not least, there is a new option called NoQueue (NOQ for short)
  151. that will not make this file available for fidonet transfers.  Basically
  152. this was added, for those people (such as myself), using the MOVE
  153. statement to move outbound packets to a point, into an inbound directory
  154. to be imported for a local (sysop) point.  This option makes it so the
  155. mailer didn't even know about the file.
  156.  
  157. A new switch has been added to JamScan.  This is to force JamScan to
  158. delete the .?LO file after it has been converted to Xferq.library.
  159.  
  160.  
  161.  
  162. -----------------------------------------------------------------------
  163.  
  164. Example Config File: (relatively complicated)
  165. ; This example uses minimal routing inside the mailer, and does a
  166. ; few non-standard things.
  167.  
  168.  
  169. ; Your Host Address (2d is required, any extra is allowed)
  170. HOST 1:163/139
  171.  
  172. ; Settings for the default priorities
  173. HOLD -50
  174. DIRECT 30
  175. CRASH 50
  176.  
  177. ; Directory where outbound bundles will be put.
  178. BUNDLES outbound:
  179.  
  180. ; Directory to search for outbound files
  181. PACKETS outbound:
  182.  
  183. ; Directory root used to create temporary compression directories
  184. PKTS outbound:packets/
  185.  
  186. ;delete flo files after converting them
  187. DELETEFLO
  188.  
  189. route 1.167.#?         ZyXELNET#18:110/0.0   lzh norm
  190.  
  191. route 1.163.139.2.#?   FidoNet#1:163/139.2   non hold move in:point2/ NOQueue
  192. route 18.163.139.2.#?  FidoNet#1:163/139.2   non hold move in:point2/ NOQ
  193. route 40.553.139.2.#?  FidoNet#1:163/139.2   non hold move in:point2/ NoQueue
  194.  
  195. route #?.163.?11.#?    FidoNet#18:163/311.0  lzh crash move out:Ottawa/
  196.  
  197. route 2.#?             ZyXELNET#16:16/0.0    lzh norm
  198. route 16.#?            ZyXELNET#16:16/0.0    lzh norm
  199. route 17.#?            ZyXELNET#16:16/0.0    lzh norm
  200.  
  201. route 19.#?            ZyXELNET#18:25/0.0    lzh norm
  202.  
  203. route 18.21.#?         FidoNet#18:21/0.0     lzh norm
  204. route 1.2402.#?        FidoNet#18:21/0.0     lzh norm
  205.  
  206. route 18.24.#?         FidoNet#18:24/0.0     lzh norm
  207. route 1.121.#?         FidoNet#18:24/0.0     lzh norm
  208.  
  209. route 18.26.#?         FidoNet#18:26/0.0     lzh norm
  210. route 1.260.#?         FidoNet#18:26/0.0     lzh norm
  211.  
  212. route 18.#?            ZyXELNET#*:*/*.0      lzh norm
  213.  
  214.  
  215. route 1.163.1?9.38.#?  FidoNet#1:163/109.38  lzh crash move out:Points/
  216. route 1.163.1?9.4.#?   FidoNet#1:163/139.4   lzh crash move out:points/
  217.  
  218. route 1.163.109.#?     FidoNet#1:163/109.0   lzh crash move out:Ottawa
  219. route 1.163.13(3|4).#? FidoNet#1:163/134.0   lzh crash move out:Ottawa/
  220. route 1.163.139.8.#?   FidoNet#1:163/139.8   lzh hold move out:Points/
  221.  
  222. route 1.163.#?         FidoNet#*:*/*.0       lzh crash move out:Ottawa/
  223. route 1.243.#?         FidoNet#*:*/*.0       lzh crash move out:Ottawa/
  224.  
  225. route (1|2|3|4|5|6).#? FidoNet#*:*/*.0       lzh direct
  226.  
  227. route 40.553.#?        AmigaNet#*:*/*.0      lzh crash move out:AmigaNet/
  228. route 40.#?            AmigaNet#*:*/*.0      lzh direct move out:AmigaNet/
  229.  
  230.  
  231. ----------------------------------------------------------------------
  232.  
  233. Example Config File: (simple)
  234. ; This example assumes all routing is done inside the tosser, and
  235. ; assumes some internal values.  All sessions are assumed to be 5d
  236. ; with the correct Domain.
  237.  
  238. ; Your Host Address (2d is required, any extra is allowed)
  239. HOST 1:163/139
  240.  
  241. ; Directory where outbound bundles will be put.
  242. BUNDLES outbound:
  243.  
  244. ; Directory to search for outbound files
  245. PACKETS outbound:
  246.  
  247. ; Directory root used to create temporary compression directories
  248. PKTS outbound:packets/
  249.  
  250. ;delete flo files after converting them
  251. DELETEFLO
  252.  
  253. route (1|2|3|4|5|6).#?.#?.#?.?LO    FidoNet#*:*/*.*    lzh norm
  254. route (39|50|41).#?.#?.#?.?LO       AmigaNet#*:*/*.*   lzh norm
  255. route (16|17|18|19).#?.#?.#?.?LO    ZyXELNet#*:*/*.*   lzh norm
  256.  
  257. ---------------------------------------------------------------------
  258.  
  259.  
  260. History:
  261.  
  262. 0.54 - initial release, October 4
  263.  
  264. 0.55 - minor tweeks, October 16
  265.  
  266. 0.56 - Adding support for converting .FLO files. (not finished)
  267.  
  268. February 94
  269. 0.57 - Raised number of route lines to 200 (the limit of 50 had been hit)
  270.        Changed to SAS 6.3 from Lattice 5.10b
  271.  
  272. March 94
  273. 0.58 - Adding pattern matching ability to destination address field
  274.        "*" is the pattern.
  275.        Back to Lattice 5.10b :-(
  276.  
  277. 0.59 - finishing up .FLO support.  Together with * pattern matching makes
  278.        things much quicker to configure for flat-file mail systems
  279.        (IE, written for TrapDoor type systems).
  280.  
  281. 0.60 - "MOVe" option added - alternative "BUNDLES" directory.
  282.        fixed stack problems
  283.  
  284. 0.61 - "NONe" option added - doesn't compress outbound .?UT files.
  285.  
  286. 0.61b - Memory problems worked on.  15k stack required.
  287.         ZIP compression requires SPAT script from WorkBench Disk installed
  288.  
  289. 0.62 - "DELETEFLO" option added so .?lo files are deleted after being
  290.         converted.
  291.  
  292. 0.62b - Fixed possible NORM problem - added "simple config" example.
  293.  
  294. 0.63 - More fixes with NORM priority of .?LO files and .?UT files.
  295.  
  296.  
  297. 0.64 - ?
  298.  
  299. 0.65 - tabs now allowed between columns :-)
  300.  
  301. 0.66 - fixed stupid bug introduced between 0.64 and 0.65 regarding reading of
  302.        .?LO files.
  303.        - possibly fixed NORM handling of non-compressed packets.
  304.  
  305. 0.67
  306. 0.68 - trying to fix up reading of .?LO files with/without paths given.
  307.  
  308. 0.69 - cleaning up some messages
  309.  
  310. 0.70 - NoQueue option added.
  311.  
  312.